Resource Library: Multimedia

home *** CD-ROM | disk | FTP | other *** search

/ Resource Library: Multimedia / Resource Library: Multimedia.iso / hypertxt / msdos / hs25 / hs.hyp < prev next >

Wrap

Text File | 1989-05-07 | 24.5 KB | 878 lines

.REMARK HyperShell hyperfile - Copyright (c) N.G.Taylor 1988,1989 .HEADER ~Tg$1~TG - $2 $N ~C55~TC$4 $5~TW ╒══════════════════════╡ ~Ty$9~TW ╞═════════════════════════╕ . .FOOTER ~L21 ~APress space bar to continue~PF+~K ~E ╘═════════════════════════════════════════════════════════════════════════════╛ F1 ~AHELP~PMHelp~E F2 ~ACONTENTS~PA@C~E F3/4 ~ABACKTRACK~PB~E F5 ~ANOTEPAD~PA@R~E F6 ~ASEARCH~PA@X?Search string~E F7 ~ATYPE FILE~PT~E F10 ~AQUIT~PQ~E . ~ANext frame~PF+~Kn~E .REMARK Global menus, notes and scripts . .MENU Help Selecting |NSelecting Contents |NContents Backtrack |NBacktrack Select back |NSelect back Noted Frames |NNoted Frames Search text |NSearch text Type File |NType File Do action |NDo action DOS Gateway |NDos Gateway Quit |NQuit Funct. keys |NFkeys Other Keys |NOther Keys Information |NInfo Colour key |NKey Noting frames |NINS Popup menus |Npopup menu Paged lists |NPaged list . .NOTE Selecting Use cursor keys or mouse to move mouse cursor to reference, or Use TAB / SHIFT TAB to move to next / previous reference. Press LEFT mouse button or RETURN to select reference. ------------------------------------ Press RIGHT mouse button or ESCAPE to select control ~Npopup menu~E. . .NOTE Help F1 Key This gives help about using the HyperShell Browser. . .NOTE Contents F2 Key This provides a complete ~Npaged list~E of the frames of text available, and allows selection of one of them from the list. . .NOTE Backtrack F3 Key This returns to the previous frame displayed, stepping back one frame at a time. The ~NF4 key~PNSelect Back~E allows you to step back any number of frames in one go. . .NOTE Select Back F4 Key This allows you to reselect a frame previously visited, from a ~Npaged list~E Repeated use of the NEXT FRAME facility and other selections will accumulate a large backtrack list and this may be 'unwound' to a selected point using this key. . .NOTE Search Text F6 Key This allows a search to be made for a text string in the document, producing a ~Npaged list~E showing the line of text containing the string and the frame within which it was found. Located frames can be selected, or noted for later viewing using the ~NINS~E key when the cursor is over their reference. Press any key during search to abort. . .NOTE Noted frames F5 Key This key allows you to select a reference previously noted using the ~NINS~E key, from a ~Npaged list~E of noted references. . .NOTE Quit F10 Key This returns to the DOS prompt. . .NOTE INS Pressing the INS key when viewing a frame or when positioned over a reference will add a reference to the noted frames list, for later selection from the ~NNoted frames~E menu. The ~NDEL~E key can be used to remove noted references from the list. . .NOTE DEL The DEL key can be used to remove noted frames from the notepad list. simply position the cursor for selection and press the DEL key. . .NOTE DOS Gateway F9 Key If you want to temporarily suspend viewing the document, press the F9 key. When you wish to return, type 'EXIT' at the DOS prompt. . .NOTE popup menu You can select from a popup menu by using the cursor keys or mouse to highlight the option to be selected, then press LEFT mouse button or RETURN (ENTER) key. Or select using function keys for F1 to F0 or shifted function keys for S1 to S0. Press RIGHT mouse button or ESCAPE key or select outside of the menu to cancel. . .NOTE Paged list Paged lists, such as the contents list, allow you to page through the list using the Pg Dn, Pg Up and Home keys. You can select a frame reference just as you do in the frame display. Some function keys may also be used in a paged list display, and depend on the list being viewed. . .NOTE Type File F7 Key This option allows you to type a text file out a page at a time, search for a string in it, and mode to a page within it. . .NOTE Do action F8 Key This option allows you to perform a HyperShell action directly. It is useful for trying out various action strings. Try P=2+3*5 as an example action string. . .NOTE Key A ~Mmenu~E gives a menu. A ~Nnote~E displays a note. A ~Freference~E allows a new frame to be selected. An ~Aaction~E does some other action. An ~Iinput field~E permits some value to be entered. . .NOTE Fkeys F1 Help F2 Contents F3 Backtrack F4 Select back F5 Notepad actions F6 Search text F7 Type file F8 Do action F9 DOS Shell F10 Quit . .NOTE Info - $9 - Frame: $1 Title: $2 File : $3 Date : $4 Time : $5 ~ABacktrack ~O2 ~PO2A;NInfo~E with $6 entries ~AAutoref ~O4 ~PO4A;NInfo~E ~AMenu symbols ~O1 ~PO1A;NInfo~E Error status $? ~C32~AClear~PYah;NInfo~E . .NOTE Other keys s Selecting i Info f Function key layout g Go to frame b Backtrack n Next frame q Quit . .SCRIPT envvar Nenvironment variable DSET . .NOTE environment variable For details on what environment variables are, see your MSDOS manual. Type SET at the DOS prompt to see the currently set environment variables. . .SCRIPT Onexit NThanks Q . .NOTE Thanks Thank you for trying HyperShell. Why not try the other demonstrations and then read the Authoring Guide to see how to develop a simple hypertext system for yourself. . .SCRIPT SETUP O# K#hMHelp K#qSOnexit K#iNInfo K#fNFkeys K#gF?Name of frame K#sNSelecting K#bB K#nF+ KF1MHelp KM1HELP KF0SOnexit Vt° Vd$ . .INDEX .CHECK of .FRAME Welcome .TITLE to HyperShell ~TG ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ ~Tg ╓ ╖ ╔═════╗ ║ ║ ║ ╖ ╖ ╖ ║ ║ ║ ║ ║ ║ ╠═══════╣ ╚═════╗ ║ ║ ║ ║ ║ ╓ ╖ ╔════╗ ╔════╗ ╔═════ ║ ╠════╗ ╔════╗ ║ ║ ║ ║ ║ ║ ║ ║ ╠════╝ ║ ║ ║ ║ ╠════╝ ║ ║ ╙ ╜ ╚════╣ ╠════╝ ╚════╝ ╙ ╚═════╝ ╙ ╜ ╚════╝ ╙ ╙ tm ────────────── ║ ║ ────────────────────────────────────────────────────── ╚════╝ ╙ ~TrThe hypertext system that's a menu system, disk manager, help system and more!~TB ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓~TW HyperShell is Copyright (c) Text Technology 1988,1989 .END .CHECK Introductory frame .FRAME Introduction .TITLE Interaction details Welcome to ~FHyperShell~E. Where do we go from here? If you have a mouse, you can use it to move the mouse cursor around the screen to certain highlit words called references, and press the left button to select the reference. Select ~FMouse~E for a full description of mouse usage. If you don't have a mouse, you can always use the keyboard. The cursor keys move the mouse cursor around. Press Tab for the next highlit field and Shift/Tab for the previous one. Press the RETURN key to select a field, or ESCAPE to cancel. Select ~FKeyboard~E for a full description of keyboard usage. If you want to exit to DOS at any point, just press 'q'. .END .FRAME HyperShell .TITLE The HyperText shell HyperShell can be set up to provide :- - Multi-file Hypertext with ~FReferences~E of various forms embedded in the text. - Help system with access to other sources of help information - Menuing system for control of your programs - Text file viewer - Directory browser / file manager - Applications user interface prototyping with pop-up menus etc. See ~FAuthoring~E for details of creating a Hypershell control file. See ~FInstallation~E for details on installing HyperShell on your system. .END .FRAME References .TITLE Types of reference in text A ~FFrame~PnFrame~Kf~E reference allows you to move to a new ~Fframe~E A ~nNote~Kn~E reference pops up a small textual note for you A ~MMenu~PnMenu~Km~E reference pops up a menu for you to choose from A ~SScript~PnScript~Ks~E reference does a sequence of ~AAction~PnAction~Ka~Es. An ~AAction~PnAction~E does a single action of some sort. The above references all pop up notes describing their usual function, rather than doing their normal function. . .NOTE Frame A frame reference allows you to move to another frame of text. To get back from that frame, you can use the backtrack facility. ~FMore on Frame references~PFFrame Reference~E .NOTE Note A note pops up a small window containing some information about the word highlighted. You are reading a note now. ~FMore on Notes~PFNote~E .NOTE Menu A menu pops up a list of items for you to select from. You can cancel the selection by clicking the mouse outside the menu or by pressing the right mouse button ~FMore on Menus~PFMenu~E .NOTE Script A script performs a sequence of actions. This may do something like displaying a series of notes, or prompting for a number of parameters for a command to be issued to DOS. ~FMore on Scripts~PFScript~E .NOTE Action An action is almost anything, including Notes, Menus, Backtracking, Prompting, issuing DOS commands or even Quitting. ~FMore on Actions~PFAction Reference~E .FRAME Frame reference .TITLE go to a frame When a frame reference is selected, the ~Fframe~E selected is displayed on the screen. Frames, or other references may be selected from this frame to further follow up the reference. When the necessary information has been found, it is possible to ~Fbacktrack~E to any of the previous frames you have seen, either one step at a time or by selecting from the ~Alist of frames~PFbacktrack list~E you have seen. Certain frame reference selections do not get added to the ~Fbacktrack~E information. .END .FRAME Note .TITLE display a note A note is a pop-up display of information. This appears in a box one quarter the size of the screen. Whilst the note may have information highlighted in it, this cannot be selected as for the main ~Fframe~E text. The note is cleared when a ~Fmouse~E button or ~Fkey~PFkeyboard~E is pressed. .END .FRAME Menu .TITLE popup a menu A pop-up menu is a list of options displayed so that a choice can be made from them. Menu options can result in any kind of ~Faction~PFactions~E, unless the menu is used to provide the ~Fparameter~PFdynamic menu~E for an action, in which case all options have the same effect. An option is chosen by moving the mouse to the menu, and clicking the ~Fleft~E button when the required option is highlighted. The menu can be cancelled by pressing the ~Fright~E mouse button, or pressing the ~Fleft~E button or any key when outside the menu. Certain menus contain ~FMenu symbols~E which show the kind of actions which will be performed when the options are selected. .END .FRAME Menu symbols .TITLE Guide to menu actions Some menus contain symbols to act as a guide to what the menu actions are. These symbols are as follows:- ƒ Frame Note ≡ Menu ≈ Script « Backtrack Ω Quit δ DOS command Σ Direct command ∞ Chained command Φ Change directory # Set key mapping α Set/test variable º Set option ° Refresh screen τ Type file π Print/popup message ≤ Open/Read file ≥ Open/write file ? Do unspecified action . .FRAME Script .TITLE perform a script A script is a sequence of ~Factions~E. These actions can be any from the set of available actions. Scripts are used for a number of purposes - to display a sequence of ~Fnote~Es, to set up a number of parameters to perform a ~FDOS~E call, to set up ~Fvariables~E to modify the displayed information etc. .END .FRAME Action reference .TITLE do some action An action reference shows that some action is to take place that is not one of the usual actions(~FMenu~E, ~FNote~E, ~FFrame~E, ~FScript~E). Selecting an action reference will have almost any effect, and hopefully the contextual information will give you some clue as to what it may be. .END .FRAME Backtrack .TITLE retracing your steps When you have followed up a ~Freference~PFreferences~E, you may wish to retrace your steps back to the initial text you were reading. The backtrack capability allows you to do this. The ~Fmain menu~E has an option called BACKTRACK, which steps you back one frame. If you wish to go directly back without having to do it one step at a time, the SELECT BACK option of the ~Fmain menu~E will allow you to choose any frame on the ~Fbacktrack list~E. .END .FRAME Backtrack list .TITLE multiple backtrack The ~Fmain menu~E provides an option to select a point in the list of text frames you have visited to which you wish to return, 'unwinding' the list of frames you have visited since, in the process. A full screen menu is presented, allowing you to select a frame reference from the frames visited. .END .FRAME Main menu .TITLE general control menu for HyperShell When you are viewing a text frame, you may request a general menu for controlling HyperShell, by pressing either the ~Fright~E mouse button or the ESCAPE key on the ~Fkeyboard~E. This menu presents a number of options. .END .FRAME Control options .TITLE choices on the main menu The main menu offers the following options:- ~FHOME~E (or ~FHELP~E) - Go to home frame (or give help) ~FCONTENTS~E - List contents of current file for selection ~FBACKTRACK~E - Backtrack one frame ~FSELECT BACK~PFbacktrack list~E - List backtrack list for selection ~FNOTEPAD~E - List noted actions for selection ~FSEARCH~E - Search current file for text string ~FTYPE FILE~E - Type contents of text file ~FDO ACTION~E - Allow action to be directly requested ~FDOS SHELL~E - Provide ~FDOS~E command subshell ~FEXIT TO DOS~E - Exit directly to ~FDOS~E . .END .FRAME HOME .TITLE Initial frame in hyperfile The HOME frame is the first ~Fframe~E in a ~Fhyperfile~E, and generally provides some kind of lead-in to the browsing of the hyperfile. It is useful to return to the home frame if you appear to be lost. The ~Fcontents~E list and the ~Fbacktrack~E list are also useful when this happens. . .FRAME HELP .TITLE Provide help menu The HELP menu is usually invoked by pressing the '?' key, although some hyperfiles may map the first control menu action (and the F1 key) to it. The help menu is an application specific set of information and will usually offer a number of note displays describing the application provided by the hyperfile. . .FRAME Next .TITLE move to next frame This option displays the next ~Fframe~E in the hyperfile. This may not be logically connected with the current ~Fframe~E, but the option is provided for sequential browsing. Return to the current frame is possible if ~Fbacktracking~PFbacktrack~E is enabled. .END .FRAME DOS SHELL .TITLE permit DOS commands This option permits a ~FDOS~E shell to be executed to allow commands to be entered at the command line. When you wish to return to ~FHyperShell~E, enter the EXIT command to the ~FDOS~E command processor. .END .FRAME CONTENTS .TITLE list contents of HyperFile This command lists the contents of the current ~Fhyperfile~E. The list is displayed a page at a time, and a selection can be made from the highlighted ~Fframe~E names, using the usual ~Freference~PFreferences~E selection mechanism. .END .FRAME DO ACTION .TITLE perform action directly This option permits an ~Faction~PFactions~E command to be entered directly. An example action would be to perform a ~FDOS~E command such as DIR /W by entering the ~Faction~PFactions~E :- DDIR /W Actions may have ~Faction modifiers~E to supply parametric information. .END .FRAME NOTEPAD .TITLE List noted actions for selection This option lists the references added to the notepad list, and permits them to be selected and followed. During this paged display, the entries on display can be removed from the notepad by pressing the Del key on the keypad when the mouse cursor is positioned over the item. All occurrences of the reference in the notepad will be removed. .END .FRAME SEARCH .TITLE Search current file for text string This option prompts for a search string and then searches the title and text of all frames in the current hyperfile for occurrences of the string. All occurrences are listed, followed by the frame name and title containing the search string. The search is a case sensitive search - uppercase and lowercase characters are searched as entered. .END .FRAME EXIT TO DOS .TITLE exit from HyperShell This action exits immediately from ~FHyperShell~E. No confirmation is sought before doing this. .END .FRAME TYPE FILE .TITLE list contents of text file The contents of the specified file are listed. The listing is presented a page at a time, and certain keys may be used for ~nmovement~E up and down the file. Other ~nkeys~E are used for control purposes. Pressing the ~Fleft~E ~Fmouse~E button or the RETURN key returns to the frame display, where subsequent selection of the TYPE FILE option returns to the file at the current point. Pressing the END button terminates the file display. The ~Fright~E ~Fmouse~E button or ESCAPE terminates the display and any current script being processed. .NOTE movement The ~TrPg Up~Ty key moves to the previous page of text, if any. The ~TrPg Dn~Ty key (and other keys) moves to the next page of text. The ~TrHome~Ty key moves to the start of the file. The ~Tr/~Ty key allows a search to be made for a string. The ~Tr#~Ty key allows a page number to be entered, and the page displayed. .NOTE keys The left mouse button or RETURN key returns to the frame display, allowing subsequent return to the file display. The END key terminates the file display. The ESCAPE key or right mouse button terminates the file display and any other script processing being done. .END .FRAME Variables .TITLE variable strings There are two classes of variable:- application variables these may be set by the HyperShell application system variables these are set by HyperShell itself Both may be expanded in the text .END .FRAME Actions .TITLE Commands for control of QuickText The Main HyperShell control actions are:- Backtrack one or more frames Chain execution of a program (not returning to HS) Execute ~FDOS~E shell or command Go to another frame Change the current directory Map a key to an action Popup a menu Popup a note Set a control option Quit to ~FDOS~E Run a script Type a file a page at a time Set an applications variable Execute a command and return to HyperShell Pop up a message, and either wait for a press or not .END .FRAME Action modifiers .TITLE Supplying action parameters An action may have its parameter supplied in some indirect fashion:- As the result of prompting you for it. As the value of a DOS ~Senvironment variable~PSenvvar~E. As a value selected from a ~Fdynamic menu~E. As a line read from a file. .END .FRAME Dynamic menu .TITLE Types of menu to supply parameters A dynamic menu is one presented during the course of some other action. It is one of the following:- Global/local ~Fmenu~E, as for text ~Freferences~E. Contents of a file as a menu ~FBacktrack list~E as a menu The current ~FHyperfile~E ~Fcontents~E list as a menu Current directory listing, with or without the file extension. Detailed directory listing, with or without auto-actions. Notepad reference display, showing contents of notepad. File listing Search results listing .END .FRAME Installation .TITLE Configuring Hypershell By default, HyperShell accesses the control files from the current directory. This is all very well for demos and ~Fauthoring~E, but not very useful when you want to access HyperShell as a help system, or as a menuing system, when you can be practically anywhere in the directory structure. To use HyperShell, you only have to put it in a directory which is on your ~Fpath~PFPATH^MSDOS~E. To pick up the control files, you should put them all in a directory somewhere, and ~Fset~PFset^msdos~E the ~Senvironment variable~PSenvvar~E associated with HyperShell, called HSPATH, to contain the ~npath prefix~E for the directory. For example:- SET HSPATH=C:\HYPSHELL\ .NOTE path prefix The path prefix should contain the pathname of the directory, and should include the drive specifier at the start and a '\' at the end. .END .FRAME Authoring .TITLE creating hypershell control files HyperShell is driven by a control file. This is a simple text file, and can be edited with a word processor or a text editor. This file is also known as a ~Fhyperfile~E. .END .FRAME hyperfile .TITLE HyperShell control file The HyperShell system is controlled by a file called a hyperfile. This is a simple text file, and can be easily set up from a text document by using a text editor or a word processor. Producing a hyperfile is known as ~FAuthoring~E. A hyperfile contains a number of ~Fframe~Es, each of which can be displayed on the screen. . .FRAME frame .TITLE unit of display A frame is a unit of textual information containing references, which is displayed during the normal operation of HyperShell. What you are reading now is a frame called 'frame'. Frames generally fit on one screen, but it is possible that they could be split onto two or more screenfuls. A list of frames in a ~Fhyperfile~E is given in a ~Fcontents~E listing. . .FRAME Mouse .TITLE Using a mouse If you have a mouse compatible with HyperShell installed on your system, with a mouse driver installed, the block cursor should respond when you push your mouse about. If it is not compatible, or if you do not have the driver installed, it will have no effect. In this case, see the ~Fkeyboard~E instructions for details of keyboard control of HyperShell. The mouse buttons should be mapped to the following keys ~Fleft~E - RETURN key (this has a <-' on it usually) ~Fright~E - ESCAPE key . .END .FRAME left .TITLE left mouse button The left mouse button, and the RETURN key, both have the same action. This is generally to select an item over which the ~Fmouse~E cursor is positioned. When viewing a text file, requested by the ~FTYPE FILE~E option from the ~Fmain menu~E, this selection returns to the frame display, on a temporary basis. . .END .FRAME right .TITLE right mouse button The right ~Fmouse~E button has two main uses:- To request the ~Fmain menu~E to control HyperShell, when viewing a text frame. This facility is not available at other times. To cancel an operation which is in progress and awaiting some input. . .END .FRAME DOS .TITLE MSDOS DOS is the operating system you most likely are using now. If you aren't, congratulations and let me know. DOS is a universal abbreviation for Disk Operating System. On the PC, it is a short version of PC-DOS or MS-DOS. .END .FRAME Keyboard .TITLE Using the keyboard The keyboard may be used in ~FHyperShell~E in a number of ways. The ~Fcursor keys~E and others can be used when viewing ~Fpaged displays~E. The ~FFunction keys~E can generally be used for control functions, and the unshifted function keys are mapped to the actions provided on the ~Fmain menu~E. Mapping these keys will alter the main menu (special names can also be mapped to alter the menu selection text for these - see the authoring guide). The RETURN and ESCAPE key have the same purpose as the ~Fleft~E and the ~Fright~E mouse buttons. The remaining keys can be mapped for control purposes or selection of ~Freferences~E. .END .FRAME Function Keys .TITLE Direct control actions The function keys, when used without the shift keys, are mapped to the main menu actions. Pressing ESCAPE, or the right mouse button, will bring up the ~Fmain menu~E to show the available control actions. .END .FRAME Cursor Keys .TITLE Selection cursor movement The cursor keys are used to move the mouse cursor, which may be positioned to enable selection for a ~Freference~PFreferences~E, or a choice on a ~Fmenu~E. .END .FRAME Paged displays .TITLE .TITLE Paged displays are used to display various lists that may occupy more than one screenful. Certain keys are available during a paged display. The keys available depend on the particular paged display, and are described in detail in the User Guide. .END